Skip to content

Omitted non-containerization sections of the Managing Hosts guide - #5092

Open
jberendz wants to merge 26 commits into
theforeman:masterfrom
jberendz:containerization_managing-hosts
Open

Omitted non-containerization sections of the Managing Hosts guide#5092
jberendz wants to merge 26 commits into
theforeman:masterfrom
jberendz:containerization_managing-hosts

Conversation

@jberendz

@jberendz jberendz commented Jul 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What changes are you introducing?

Omitted sections of the Managing Hosts Guide that are not used in containerization.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Placed all content from "Configuring and setting up remote jobs", "Using custom SSL certificates for hosts", and all references to pull mode/mqtt in ifndef tags since it is not used in containerization.

Relates to SAT-47769, SAT-47780, SAT-47773, SAT-47764, SAT-47766, SAT-47768, SAT-47770, SAT-47771, SAT-47775, SAT-47777, SAT-47778, SAT-47779, SAT-47780, SAT-47783, SAT-47772, SAT-47783, SAT-47758, SAT-47782.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.19/Katello 4.21
  • Foreman 3.18/Katello 4.20 (Satellite 6.19; orcharhino 7.9)
  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6, 7.7, and 7.8)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • We do not accept PRs for Foreman older than 3.14.

@github-actions github-actions Bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Jul 21, 2026
@github-actions

github-actions Bot commented Jul 21, 2026 •
edited
Loading

Copy link
Copy Markdown

The PR preview for 65e319e is available at theforeman-foreman-documentation-preview-pr-5092.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@jberendz
jberendz marked this pull request as ready for review July 21, 2026 21:20
@jberendz
jberendz marked this pull request as draft July 21, 2026 21:20
@jberendz
jberendz marked this pull request as ready for review July 22, 2026 17:14
jberendz
jberendz commented Jul 22, 2026
View reviewed changes
Comment thread guides/common/modules/con_transport-modes-for-remote-execution.adoc Outdated
@jberendz jberendz changed the title Omitted non-containerization sections. Omitted Non-containerization Sections of the Managing Hosts Guide Jul 22, 2026
@jberendz jberendz changed the title Omitted Non-containerization Sections of the Managing Hosts Guide Omitted non-containerization sections of the Managing Hosts guide Jul 22, 2026
maximiliankolb
maximiliankolb reviewed Jul 23, 2026
View reviewed changes
Comment thread guides/common/modules/con_transport-modes-for-remote-execution.adoc Outdated
Comment thread guides/common/modules/con_transport-modes-for-remote-execution.adoc Outdated
@jafiala jafiala removed the Needs testing Requires functional testing label Jul 23, 2026
chris1984
chris1984 reviewed Jul 23, 2026
View reviewed changes

@chris1984 chris1984 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, agree with removing the slightly better sayings that @jafiala suggested. Can we get a preview of what the guide looks like with all the ifndef changes

@jberendz

jberendz commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Looks good overall, agree with removing the slightly better sayings that @jafiala suggested. Can we get a preview of what the guide looks like with all the ifndef changes

Hi Chris, thanks for the review. Run the following commands for the preview:

  1. In the foreman-documentation repo, cd into guides/doc-Managing_Hosts.
  2. Run make BUILD=satellite browser. A new tab should open on your browser or a popup to open the file will appear.

@maximiliankolb

maximiliankolb commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Can we get a preview of what the guide looks like with all the ifndef changes

The first comment on this PR contains a link to built docs based on this feature branch.

maximiliankolb
maximiliankolb reviewed Jul 24, 2026
View reviewed changes
Comment thread guides/common/assembly_package-mode-and-image-mode-hosts.adoc
chris1984
chris1984 reviewed Jul 24, 2026
View reviewed changes

@chris1984 chris1984 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am seeing this in 6.1:

You can register the following hosts for converting to RHEL:
CentOS Linux 7
Oracle Linux 7 and 8

Should we add an indef for this, since we can't do convert2rhel currently with containers

Also does it have the other omitions from the other cards we did, since they are all assigned to you, I forgot the others I did.

@jberendz

jberendz commented Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

I am seeing this in 6.1:

You can register the following hosts for converting to RHEL:
CentOS Linux 7
Oracle Linux 7 and 8

Should we add an indef for this, since we can't do convert2rhel currently with containers

Also does it have the other omitions from the other cards we did, since they are all assigned to you, I forgot the others I did.

Yes, we should block that part out too. I will submit another update shortly.

The PR covers everything except the following chapters since they needed additional followup:

  • Reviewing hosts in Satellite web UI
  • Host management and monitoring by using the RHEL web console
  • Installing Flatpak applications on host (this chapter is excluded, but I have a followup question about an appendix since it is related to the chapter)
  • Registering hosts to Satellite (two more subsections got added to the exclusion list)

chris1984
chris1984 approved these changes Jul 27, 2026
View reviewed changes

@chris1984 chris1984 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I would remove the flatpak wording as you pointed out in the Jira comment. Otherwise looks good.

@jberendz
jberendz force-pushed the containerization_managing-hosts branch from eef77fa to 56321b4 Compare July 27, 2026 20:01
@jberendz jberendz mentioned this pull request Jul 27, 2026
Open
8 tasks
maximiliankolb
maximiliankolb reviewed Jul 28, 2026
View reviewed changes
Comment thread guides/common/assembly_registering-hosts-to-project.adoc
Comment thread guides/doc-Managing_Hosts/master.adoc Outdated
@jafiala jafiala added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Jul 28, 2026
This was referenced Jul 28, 2026
Open
Draft
jafiala
jafiala reviewed Jul 29, 2026
View reviewed changes
Comment thread guides/common/assembly_registering-hosts-to-project.adoc Outdated
@jafiala

jafiala commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The branch has conflicts with master. Please rebase against master and resolve them.

jberendz and others added 22 commits July 29, 2026 11:15
@jberendz
adjusting abstract to transport-modes-for-remote-execution
87e7e78
@jberendz
reordering tags for assembly
5b6115f
@jberendz
testing ifndef inside of ifeval
4619686
@jberendz
cleaning up ifndef brackets
d6aba32
@jberendz
troubleshooting nesting tags
de87d4d
@jberendz
troubleshooting nested ifeval/ifndefs
fa17e99
@jberendz
Troubleshooting nested ifeval and inndef tags
ac70c7f
@jberendz
Omitting Converting Hosts to RHEL section
709a3c3 
SAT-47773 is not used in containerization and can
be removed with other similar requests to remove
sections.
@jberendz
Including ifdef topics for easier review
08f3325
@jberendz @maximiliankolb
Update guides/common/modules/con_transport-modes-for-remote-execution…
20a3084 
….adoc

Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>
@jberendz @maximiliankolb
Update guides/common/modules/con_transport-modes-for-remote-execution…
e71b6de 
….adoc

Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>
@jberendz
Addressing build errors and review comments
78524f1
@jberendz
fixing wrapper error
c4b5dbc
@jberendz
attempting to nest abstract within ifdef
7c4c52c
@jberendz
reverting changes
3531b74
@jberendz
fixing vale error
5d6164c
@jberendz
removing vale error to escalate with sme
3a88fc9
@jberendz
addressing feedback
bea2802
@jberendz
reverting excluding assembly that breaks vale
993f55e
@jberendz @maximiliankolb
Update guides/doc-Managing_Hosts/master.adoc
717cb12 
Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>
@jberendz
cleanup
2e0cdc0
@jberendz
remove ifdef guard for bootstrap
01482af
@jberendz
jberendz force-pushed the containerization_managing-hosts branch from e194d84 to 01482af Compare July 29, 2026 15:16
@jafiala jafiala added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Jul 30, 2026
maximiliankolb
maximiliankolb reviewed Jul 30, 2026
View reviewed changes
Comment thread guides/common/modules/proc_installing-errata-on-hosts-by-using-cli.adoc Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maximiliankolb maximiliankolb maximiliankolb left review comments
@jafiala jafiala jafiala approved these changes
+2 more reviewers
@jeremylenz jeremylenz jeremylenz left review comments
@chris1984 chris1984 chris1984 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jberendz @maximiliankolb @jafiala @chris1984 @jeremylenz